Hybris UX Api
TMF639 - getphysicalResource By ID
This operation allows to retrieve status of SIM(ICCID) Numbers.
URL
http://[localhost]:[port]/ecom-ux/v1/{businessId}/physicalResource/{id}URL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | String | 2 letter ISO 3166 country code (PA) identifying the business unit. | Y |
| id | String | Unique identifier of ICCID value | Y |
Headers
| name | type | description | required |
|---|---|---|---|
| client_id | String | The client-id identifying the channel. | Y |
| client_secret | String | Password associated with the client-id. | Y |
| X-Correlation-ID | String | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | N |
Query Params
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|---|---|---|
| @type | String | Defines the entity name. Eg: "SIM" | Y (PA) |
| resourceStatus | String | Status of the resource , Possible Values: "unknown" | Y(PA) |
Data Model
Response Body
| field name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|---|---|---|
| serialNumber | String | Identifier of a physical resource. Required to be unique within the resource type. | Y(PA) |
| category | String | defines the resource name | N(PA) |
| resourceStatus | String | Status of the resource. Possible Values: "Active" | Y(PA) |
| resourceCharacteristic[].name | String | Name of the characteristic | Y(PA) |
| resourceCharacteristic[].value | String | Value of the characteristic | Y(PA) |
| resourceRelationship[].relationshipType | String | Type of the resource relationship, such as "paired" if the resource is paired with another resource | N(PA) |
| resourceRelationship[].resourceRelationshipCharacteristic[].name | String | possible values : "IMSI" | N(PA) |
| resourceRelationship[].resourceRelationshipCharacteristic[].value | String | International Mobile Subscriber Identity value, a unique identifier for a SIM card. | N(PA) |
resourceCharacteristic subResource -Data Model
| field name | type | description | required (mandatory-Y, optional-N,conditionallyMandatory-C/M, Not applicable- N/A) | examples |
|---|---|---|---|---|
| resourceCharacteristic[].name == "pin1" | String | Personal Identification Number used to lock the eSIM card for security. | Y(PA) | PA: { "name":"PIN1", "value":"0123" } |
| resourceCharacteristic[].name == "pin2" | String | Secondary PIN used for specific eSIM-related operations, like managing services. | Y(PA) | PA: { "name":"PIN2", "value":"1234" } |
| resourceCharacteristic[].name == "puk1" | String | Personal Unblocking Key used to unblock the eSIM after multiple incorrect PIN1 attempts. | Y(PA) | PA: { "name":"PUK1", "value":"3177" } |
| resourceCharacteristic[].name == "puk2" | String | Personal Unblocking Key used to unblock the eSIM after multiple incorrect PIN2 attempts. | Y(PA) | PA: { "name":"PUK2", "value":"3177" } |
| resourceCharacteristic[].name == "prepaidInd" | String | Indicates whether the eSIM card is for a prepaid service (True/False). | Y(PA) | PA: { "name":"prepaidInd", "value": false } |
| resourceCharacteristic[].name =="sim-provid" | String | retrieving sim info | Y(PA) | PA: { "name": "SIM-PROVID", "value": "05.06" } |
Key considerations
PA Implementation
- To retrieve status of physical SIM, applicable queryParams are: @type, resourceStatus.
- Expected value for '@type' is : 'SIM'
- Expected value for 'resourceStatus' is : 'unknown'
Note : For response examples please refer to below sample example:
response - "PA-Retrieve-Physical-SIM-Status" in API specification